home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / dev / misc / makedoc_v1_1.readme < prev    next >
Encoding:
Text File  |  1995-02-13  |  6.7 KB  |  162 lines
  1. Short:  Autodoc like doc-extraction utility v1.1
  2. Author: Stefan Ruppert
  3. Type:   dev/misc
  4.  
  5. makedoc                                                                 makedoc
  6.  
  7. $VER: makedoc.doc 1.1 (08.05.94)
  8.  
  9. NAME
  10.     makedoc
  11.  
  12. FORMAT
  13.     makedoc [FILES] file1 [file2] [...] AUTODOC docfile [TEMPFILE temporyfile]
  14.             [BEGIN string] [END string] [SKIPSTRING string] [TABS numspcs]
  15.             [LINELENGTH numchars] [CONVERTCOMMENTS] [NOWORDWRAP] [NOFORMFEED]
  16.             [TOC] [LANGUAGE lang] [AMIGAGUIDE] [NOICON] [VERBOSE]
  17.             [APPEND file] [VERSION version-number] [REVISION revision-number]
  18.             [REVISIONFILE file]
  19.  
  20. TEMPLATE
  21.     FILES/M/A,AUTODOC/K/A,TEMPFILE/K,BEGIN/K,END/K,SKIPSTRING/K,TABS/N,
  22.     LINELENGTH/N,CONVERTCOMMENTS/S,NOWORDWRAP/S,NOFORMFEED/S,TOC/S,
  23.     LANGUAGE/K,AMIGAGUIDE/S,NOICON/S,VERBOSE/S,APPEND/K,VERSION/N,
  24.     REVISION/N/K,REVISIONFILE/K
  25.  
  26. FUNCTION
  27.     extracts documentfragments from source code files and saves this in a
  28.     documentation file in sorted order (Format : AutoDoc).
  29.     Makedoc supports extraction of different languages for a documentation.
  30.     To do that , you must specifiy in the BEGIN string the "LL" substring,
  31.     to match at this point the different langauges with the following
  32.     abbreviation :
  33.  
  34.       "DK" -    dansk
  35.       "D?" -    deutsch
  36.       "E?" -    español
  37.       "F?" -    français
  38.       "GB" -    english
  39.       "I?" -    italiano
  40.       "NL" -    nederlands
  41.       "N?" -    norsk
  42.       "P?" -    português
  43.       "S?" -    svenska
  44.  
  45.     Makedoc creates also icons for a documentation, if the NOICON option
  46.     isn't specified. Makedoc looks first for the Env:sys/def_doc.info
  47.     icon and if this doesn't exist it uses the WBPROJECT icon !
  48.     If you specify a REVISIONFILE makedoc searches in the found documentation-
  49.     fragments for the version pattern : "$VER: " and if it founds it, it fills
  50.     teh appropriate values in (VERSION,REVISION,NAME and DATE).
  51.  
  52. INPUT
  53.     FILES - one or more sourcefiles
  54.     AUTODOC - AutoDoc file to create. If no language is specified , then
  55.         makedoc searches here for a language specific directory-name. For
  56.         example a full path like the following use the english language to
  57.         extract the documentation : doc/english/test.doc
  58.     TEMPFILE - tempory file to use
  59.     BEGIN - String, which indicates the beginning of a documentation fragment
  60.         (Default : "/******")
  61.     END - String, which  indicates the end of documentation fragment
  62.         (Default : "***")
  63.     SKIPSTRING - String, which is skipped at the beginning of each line in the
  64.         documentation fragment (Default : "*")
  65.     TABS - number of blanks to replace a tabulator
  66.     LINELENGTH - maximal length of a line (Default : 78)
  67.     CONVERTCOMMENT - converts backslashes to slash, if before or after there
  68.         is an asterik
  69.     NOWORDWRAP - turns wordwrap off
  70.     NOFORMFEED - turns formfeed off , after each documentation fragment
  71.     TOC - creates at the beginning of the Autodoc a table of contents
  72.     LANGUAGE - specifiy the langauge for the documentation to be extracted.
  73.         See list of languages above.
  74.     AMIGAGUIDE - places a @node before and a @endnode after the
  75.         documentation fragment. Thus you have AmigaGuide Nodes !
  76.     NOICON - creates no icons for the AutoDoc file 
  77.     VERBOSE - shows parse informations
  78.     APPEND - file to append at the end of the documentation
  79.     VERSION - version number of the documentation/program (Default : 0)
  80.     REVISION - revision number of the documentation/program
  81.     REVISIONFILE - file, which contains the revision of the documentation/
  82.         program (see bumprev).This argument overrides the REVISION argument
  83.         and additionly it uses the date of the file for the $VER: date.
  84.  
  85. EXAMPLE
  86.     makedoc test.c AUTODOC test.doc BEGIN "/**LL******" END "******" \
  87.             SKIPSTRING "**" TOC VERBOSE NOFORMFEED LANGUAGE english
  88.  
  89.     or
  90.  
  91.     makedoc test.c AUTODOC doc/english/test.doc BEGIN "/**LL******"  \
  92.             END "******" SKIPSTRING "**" TOC VERBOSE
  93.  
  94.     extracts only following fragments :
  95.  
  96.     /*GB*** test.lib/test.c **************************************************
  97.     *
  98.     * here the documentation
  99.     *
  100.     ***** END of documentation **********************************************/
  101.  
  102.     The following command , extracts only fragments for menus :
  103.  
  104.     makedoc test.c AUTODOC test.doc BEGIN "/**LL**MENU**" END "******" \
  105.             SKIPSTRING "**" TOC VERBOSE NOFORMFEED LANGUAGE english
  106.  
  107.     extracts only fragments like the following :
  108.  
  109.     /*GB*MENU* Menu/Project/Open *********************************************
  110.     *
  111.     * here the menu-documentation
  112.     *
  113.     ***** END of Menu-documentation *****************************************/
  114.  
  115. NOTE
  116.     makedoc uses ReadArgs to parse the command line, thus if you specify a "*"
  117.     in a string , you must do this twice for each character you want. ReadArgs
  118.     uses this character to output special characters like a newline.
  119.  
  120. SYSTEM REQUIREMENT
  121.     Any Amiga with at least OS2.04 (V37) or higher.Look out for OS3.x, it's
  122.     a great improvement to OS2.04 (see Datatypes ...) !!!
  123.  
  124. SEE ALSO
  125.     autodoc
  126.  
  127. COPYRIGHT
  128.     (C) Copyright 1993,1994 by Stefan Ruppert
  129.     Makedoc is freely distributable, if any file in Contents-List is not
  130.     modified and copied.
  131.  
  132. IDEAS,BUGS ?,GIFTS,PROGRAMS AND AMIGAS TO
  133.     Stefan Ruppert
  134.     Windthortstraße 5
  135.     65439 Flörsheim am Main
  136.     Germany
  137.  
  138.  
  139. ============================= Archive contents =============================
  140.  
  141. Original  Packed Ratio    Date     Time    Name
  142. -------- ------- ----- --------- --------  -------------
  143.      628     268 57.3% 23-Oct-94 19:20:12  makedoc.info
  144.      454     241 46.9% 24-Aug-94 18:11:38  makedoc/contents
  145.      439     120 72.6% 24-Aug-94 18:01:06  makedoc/contents-list
  146.      464     224 51.7% 24-Aug-94 17:59:52  makedoc/contents.info
  147.      628     277 55.8% 24-Aug-94 17:59:52  makedoc/doc.info
  148.      628     265 57.8% 08-May-94 13:40:12  makedoc/doc/deutsch.info
  149.     5983    2439 59.2% 09-Jan-95 18:24:42  makedoc/doc/deutsch/makedoc.dok
  150.      468     226 51.7% 30-Apr-94 14:22:56  makedoc/doc/deutsch/makedoc.dok.info
  151.      628     267 57.4% 08-May-94 13:40:20  makedoc/doc/english.info
  152.     5346    2120 60.3% 09-Jan-95 18:24:42  makedoc/doc/english/makedoc.doc
  153.      468     226 51.7% 30-Apr-94 14:22:58  makedoc/doc/english/makedoc.doc.info
  154.     6212    4025 35.2% 09-Jan-95 18:24:40  makedoc/makedoc
  155.      834     292 64.9% 24-Aug-94 17:59:52  makedoc/makedoc.info
  156.      361     240 33.5% 08-May-94 11:59:28  makedoc/makedoc.rev
  157.      628     274 56.3% 24-Aug-94 17:59:52  makedoc/test.info
  158.      385     166 56.8% 30-Apr-94 16:20:06  makedoc/test/maketestdoc
  159.     1123     398 64.5% 30-Apr-94 12:59:40  makedoc/test/test.c
  160. -------- ------- ----- --------- --------
  161.    25677   12068 53.0% 10-Jan-95 13:39:46   17 files
  162.